home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / nyword20.arc / INTRO.DOC < prev    next >
Text File  |  1986-06-02  |  18KB  |  400 lines

  1.                   THE "NEW YORK WORD" WORD PROCESSOR
  2.                               RELEASE 1.2
  3.  
  4.                             MAGMA SYSTEMS
  5.                          138 - 23 HOOVER AVE.
  6.                        JAMAICA, NEW YORK  11435
  7.                            (718) 793 - 5670
  8.  
  9.     This  ARC  file  contains  release  1.2  of the New York Word word
  10. processor, dated 3/15/86. The ARC file contains the following files :
  11.  
  12.   WP.EXE    - the executable version of the word processor
  13.   WPDEFAUL  - system config file
  14.   WPFORMAT  - format block 0 config file
  15.   WPPRMENU  - printer menu config file
  16.   *.PRT     - printer code config files
  17.   *.DOC     - introduction, history, installation, registration
  18.   NYWHELP.* - help menus
  19.  
  20.     The "New York Word" word processor (hereby referred to as NYW)  is
  21. a powerful text editing and formatting tool. It has many advanced fea-
  22. tures  which  you  don't  even  find in the commercial word processing
  23. packages. Some of the advanced features are :
  24.  
  25. - Split screen editing, with the ability to move text between windows
  26. - Macros of unlimited length
  27. - Regular expressions in the search & substitute facility
  28. - Global Substitution
  29. - Two calculator modes (desk and text)
  30. - ASCII line-drawing characters
  31. - Full footnoting capabilities
  32. - Multiple headers & footers
  33. - Columnar operations (copying, moving, deleting, blanking)
  34. - Automatic table-of-contents and index generator
  35. - Knuth automatic hyphenation algorithm
  36. - Powerful mail merge facility, including a programming language
  37. - Unix version interfaces to the UNIX spelling program
  38.  
  39.  
  40.     NYW  was  written  almost  totally  in  C, with a few I/O routines
  41. optimized in assembly language. Lattice C version 2.14 was used, large
  42. model, with stack checking included (probably accounting for about  1K
  43. of  excess  code).  PLink86  was  used  for the linker - the footnote,
  44. calculator, printer, paginator, and table of  contents/index  routines
  45. are overlaid to save space.
  46.  
  47.     I   would   really   appreciate   any  bug  reports,  suggestions,
  48. enhancements, etc. This is YOUR program. Source code is available at a
  49. yet-to-be-decided price, so contact me if interested. If  any  of  you
  50. are good C programmers and feel like helping out, then contact me too.
  51. In  particular,  I'm  interested in proportional spacing algorithms (I
  52. would like to do something with kerning), spelling algorithms, and who
  53. knows what else. Even if you don't have the source code, I  am  always
  54. eager to discuss the technical aspects of NYW.
  55.  
  56.     As   mentioned   in  the  documentation,  this  is  user-supported
  57. software. If you end up using this  program,  a  donation  of  $35  is
  58. requested.  This will enable me to further develop NYW, and defray the
  59. cost of postage, disks, and phone  bills.  Registered  users  will  be
  60. entitled  to receive a user's manual, any upgrades, and the below men-
  61. tioned mail-merge program and label printer. The next upgraded version
  62. should have a keyboard re-map facility (the UNIX version  already  has
  63. one).
  64.  
  65.  
  66. FUTURE ENHANCEMENTS
  67.  
  68.     Integration with a spelling checker (PC version only). I would ap-
  69. preciate comments on existing spelling programs out  there,  and  what
  70. you  would  like  to  see  in  an ideal spelling checker. Keep a slant
  71. towards public-domain programs.
  72.  
  73.     Keystroke  re-definition  facility.  The  UNIX  version  uses  the
  74. termcaps  database  to represent every word processor command as a two
  75. character symbol, and the user is able to remap the entire keyboard. I
  76. didn't want to use termcaps  in  the  PC  version,  partly  for  legal
  77. reasons,  partly  for  speed reasons. The keyboard re-mapping facility
  78. will be available only to registered users.
  79.  
  80.     A better looking version just for the PC. My idea is to  keep  the
  81. PC and UNIX versions similar, so I can maintain both easily. If the PC
  82. version seems to do well in the public domain, I will try to snazz NYW
  83. up  so it looks like a PC product. Possible enhancements include color
  84. support, better keystroke interpretation (to differentiate between the
  85. different shift statii), etc.
  86.  
  87.  
  88. THE USER-SUPPORTED CONCEPT
  89.  
  90.     The PC verion of this program has been placed in circulation under
  91. the  "user-supported  software"  concept.  Non-profit  clubs  and  in-
  92. dividuals  are  encouraged  to  make  copies of this software and dis-
  93. tribute it to their members and friends so long as no charge  is  made
  94. for  the  software and documentation. However, a distibution charge of
  95. no more than $10 may be charged for the cost of the diskettes.
  96.  
  97.     Under the user-supported concept, you are given a complete,  work-
  98. ing  product for no charge. If you find yourself using this program, a
  99. contribution of $35 is suggested. The money will cover the cost of bug
  100. fixes, future developments, postage, telephone bills, etc.
  101.  
  102.     The contribution will make you a registered user. As a  registered
  103. user,  you are entitled to things like updates, support, and a copy of
  104. the user's manual. A registration form is enclosed  in  this  documen-
  105. tation.
  106.  
  107. SOURCE CODE
  108.  
  109.     Source  code  is  available  for both the IBM PC and the UNIX ver-
  110. sions. The entire code is written in  the  'C'  programming  language,
  111. with  the  PC  version  containing  a  few assembly language routines.
  112. Please contact me for availablility of the code.
  113.  
  114. THE UNIX VERSION
  115.  
  116.     If you would like me to port this package to  your  UNIX  machine,
  117. please  contact  me. The UNIX version is still available commercially.
  118. If your company is interested in marketing this package, exclusive and
  119. non-exclusive distribution rights are available. This package is  also
  120. available to OEM's wishing to develop their own applications.
  121.  
  122. DISCLAIMER
  123.  
  124.     Marc  Adler  and  Magma Systems will in no event be liable for any
  125. damages, including lost profits, lost savings, or other incidental  or
  126. consequential  damages  arising  out of the use or of the inability to
  127. use this program.
  128.  
  129.  
  130.                               Marc Adler
  131.                             MAGMA SYSTEMS
  132.                          138 - 23 Hoover Ave.
  133.                        Jamaica, New York  11435
  134.  
  135.     Below I have included the prospectus that goes along with the UNIX
  136. version of NYW (still commercially available - contact me). All of the
  137. features, except the spelling checker, are present in the PC version.
  138.  
  139.     Enjoy!!!
  140.  
  141.                                 Marc Adler
  142.                                 3/15/86
  143.  
  144.  
  145.  
  146.                    THE "NEW YORK WORD" WORD PROCESSOR
  147.  
  148.  
  149. BACKGROUND
  150.  
  151.    The New York  Word  (NYW)  was  created  in  1984  to  run  on
  152. computers  which  use the UNIX(TM) operating system. UNIX is fast
  153. becoming the industry standard in operating systems, as witnessed
  154. by the support of such major companies as IBM, AT&T, and DEC.  In
  155. late  1985,  NYW  was  ported  to  run under MS-DOS, the standard
  156. operating  system  for  the  IBM  Personal  Computer.  NYW  is  a
  157. state-of-the-art  word processing package available at a low cost
  158. to end-users and  OEMs.  Source  code  is  also  available  at  a
  159. reasonable cost.
  160.  
  161.    NYW  is capable of supporting a multi-user environment without
  162. noticeable degradation  of  the  system.  There  is  currently  a
  163. 30-user  installation running at a major government instituion in
  164. Washington DC. 
  165.  
  166. FLEXIBLE AND FAST
  167.  
  168.   NYW utilizes your system's main memory  to  the  fullest.  This
  169. way,  you  can  have  complete  random access to any part of your
  170. document. Operations like reformatting (global or paragraph)  and
  171. re-pagination seem to happen in an instant. With the introduction
  172. of  CPU's  (like  the Motorola 68020) which have built-in virtual
  173. memory hardware, you can edit extremely large text files  totally
  174. in memory. 
  175.  
  176.    When  a  user  starts  an NYW editing session, the NYW program
  177. examines several files. These files contain the default values of
  178. several  parameters  which  affect  the  editing  session.  These
  179. parameters  deal  with  items like margin settings, tab settings,
  180. printer options, session modes, etc. By changing  the  values  in
  181. these  default  files, a user can customize an editing session to
  182. suit his particular needs. 
  183.  
  184. GENERAL EDITING FEATURES
  185.  
  186.    NYW has a full complement  of  editing  features.  The  cursor
  187. movement   commands   allow  you  to  move  up  and  down  lines,
  188. paragraphs, and pages. or can go directly to any line number,  or
  189. any  number of lines relative from where the cursor currently is.
  190. You can place up  to  26  bookmarks  at  various  points  in  the
  191. document,  and  return  to  any point at any time. You can scroll
  192. continuously up or down  the  document,  with  a  user-selectable
  193. scrolling speed. 
  194.  
  195.    There  are  ten  buffers  which  you  can  use  to  store text
  196. temporarily. By using these buffers, you can  move  or  copy  any
  197. portion  of text from one place to another. You can mark a region
  198. of text and then delete it, save it, write it out to a file, draw
  199. a box around it, or change the case of the letters in it. 
  200.  
  201.    To enhance your document, you can choose from special  effects
  202. like   boldfacing,  underlining,  overstriking,  subscripts,  and
  203. superscripts. If your printer is capable of it,  you  can  change
  204. fonts  at any point in the document. There are also several kinds
  205. of tabs - regular, decimal, center, and flush right. 
  206.  
  207.    Pagination is extremely fast. You can re-paginate  a  document
  208. at   any   point,  and  NYW  will  renumber  the  pages  for  you
  209. automatically. You can choose to handle widow and orphan lines to
  210. produce a cleaner looking document. 
  211.  
  212.    NYW  allows  you to have multi-line header and footers in your
  213. document. You can even put in  "temporary"  headers  and  footers
  214. which  will  appear  on  the printer, but will not be saved along
  215. with the document. 
  216.  
  217.    Other desireable features are an escape to the UNIX/DOS shell,
  218. and the ability to redirect the output of  a  command  into  your
  219. document. 
  220.  
  221. FOOTNOTES
  222.  
  223.    NYW has  full  footnote  capabilities,  with  the  ability  to
  224. automatically  renumber  footnotes  when  you  insert or delete a
  225. footnote. You have your choice of having the footnotes appear  at
  226. the  end  of  a  page,  or  the  end  of a document. You can edit
  227. footnotes as if they were regular text, or flash a listing of the
  228. currently defined footnotes across the screen. 
  229.  
  230. MACROS
  231.  
  232.    NYW  has  full  macro  capabilities. You can intermix text and
  233. keystroke commands in a macro and replay them at  any  time.  You
  234. can also have libraries of macros, which you can read at any time
  235. into your editing session. Any macros you define in a  file  will
  236. be  saved  along with that file - thus you can build up an entire
  237. dictionary of macros which can be inserted in a file at any time.
  238. This is useful for "skeleton" documents, where you  can  take  an
  239. outline  of a letter and paste text (ie macros) at various points
  240. in the letter. 
  241.  
  242.    Another  feature which greatly aids the user is the ability to
  243. "capture" keystrokes.  If  the  user  must  repeat  a  series  of
  244. keystrokes  a  few  times  in  a  row, then the user can type the
  245. series in once, watch the effect the commands have,  then  replay
  246. the series an arbitrary number of times. 
  247.  
  248. TABLE OF CONTENTS & INDEX GENERATION
  249.  
  250.    NYW  comes  with  an  automatic  table  of  contents and index
  251. generator.  The  user  has  a  choice  of  having  the  toc/index
  252. generated  at  the  beginning/end  of the file, or written out to
  253. another  document.   The   index   generator   will   also   take
  254. consecutively  numbered pages (ie 4,5,6,8,9,10) and express those
  255. pages as a range (ie - 4-6,8-10). 
  256.  
  257. SPELLING CHECKER
  258.  
  259.    NYW also interfaces with the UNIX spelling program,  which  is
  260. an  extremely  powerful  spelling  checker.  (See  the  Bell Labs
  261. memorandum by McIlroy). It also has a spelling corrector - if you
  262. chose, you have have suggested correct  spellings  flash  on  the
  263. screen. The advantage of interfacing to the UNIX spelling checker
  264. is  that  no  extra  space  is  required  for  a  massive English
  265. dictionary. The user can also maintain his own private dictionary
  266. which is checked along with the regular dictionary. 
  267.  
  268. AUTOMATIC HYPHENATION
  269.  
  270.    NYW has automatic hyphenation. It uses  a  cross  between  the
  271. Knuth  algorithm (incorporated in his TEX system), and the Gimpel
  272. algorithm.  This  provides  a  fast,  accurate  hyphenator.  This
  273. algorithm  has  been tested on a dictionary of 2000 common words,
  274. and it performs virtually without error. 
  275.  
  276. MAIL MERGE FACILITY
  277.  
  278.    The mail merge facility is extremely powerful, and  gives  the
  279. user  a  small  programming language to do run-time calculations.
  280. These  calculations  can  be  merged  into  a  letter,  and  then
  281. recalculated for the next letter. The YACC compiler-generator was
  282. used  to  write  this  language,  which  has a full complement of
  283. arithmetic and string operations, along with  block  if-then-else
  284. statements. 
  285.  
  286.    There are several utility programs which come with NYW to make
  287. the  mail  merge  program  more powerful. These programs take the
  288. output of the mail merge program, and "filter"  it  in  different
  289. ways so the user can use the results in another process. 
  290.  
  291.    One  is  a  label  generating  program,  which  gives the user
  292. parameters for the number of columns in  a  row  of  labels,  the
  293. height  of  each label, and the width of each label. This program
  294. can intermix labels which have a different number of lines - this
  295. was traditionally a short-coming of many mail merge programs,  as
  296. you  had  to maintain a separate mailing list for addresses which
  297. had 3, 4 and 5 lines. 
  298.  
  299.    We also can interface the mail merge program with popular UNIX
  300. packages like Supercomp or Unify. We can write a  custom  program
  301. so  the  output of the mail merge facility can be interfaced with
  302. your favorite program. 
  303.  
  304.  
  305. REGULAR EXPRESSIONS
  306.  
  307.      The UNIX(TM) operating system pioneered the use  of  regular
  308. expressions in pattern matching. Regular expressions allow you to
  309. search  for  a  context,  such  as  "all lines beginning with the
  310. letter a,b, or c", or "any occurence of two numbers followed by a
  311. letter".  NYW  incorporates  regular       expressions  into  its
  312. search-and-substitute   facility   to   allow   powerful  pattern
  313. matching. You can also use regular expressions  in  NYW's  global
  314. substitution facility. 
  315.  
  316. TERMINAL INDEPENDENCE
  317.  
  318.    A  problem with many word processors is that they are designed
  319. to work with only one kind of terminal. NYW can be configured  to
  320. work  with  any intelligent alpha-numeric terminal in a matter of
  321. hours.  It  uses  a  database  of  information   concerning   the
  322. characteristics  of  terminals,  and  it  will  look  through the
  323. database for the type of terminal you specify when you start  up.
  324. Since the database is kept in character form, you can easily edit
  325. it to add your own type of terminal. 
  326.  
  327.    Along with the information about terminal characteristics, the
  328. database  includes  information about the keystrokes you press to
  329. invoke each NYW command. By changing this  information,  you  can
  330. alter  the  keystrokes you press to invoke any command. With this
  331. facility, you may want to put frequently  used  commands  on  the
  332. terminal's  function  keys,  and  make  the  less frequently used
  333. commands an ESCAPE key combination. 
  334.  
  335. SPLIT-SCREEN EDITING
  336.  
  337.    Many times when you edit a document, you may wish that you can
  338. see another document on the screen at the same time. NYW can edit
  339. two  documents  or  different  parts   of   the   same   document
  340. simultaneously,  each  document in its own separate window on the
  341. screen. You can move or copy text from one window to the another.
  342. The size of each window can be altered by the user,  so  you  can
  343. have  a  window as little as 2 lines long, or both windows can be
  344. full-screen size. 
  345.  
  346. MATH CALCULATIONS
  347.  
  348.    There  are two kinds of calculators that come with NYW. One is
  349. a desk calculator  that  allows  fully  parenthesizes  arithmetic
  350. expressions.  You  can enter this calculator from the middle of a
  351. NYW editing session in order to do some quick  calculations.  The
  352. desk  calculator  comes  with  memory that can be recalled at any
  353. instant. 
  354.  
  355.    The second  calculator  operates  on  numbers  that  you  have
  356. embedded  in  the  document  you  are  editing.  You can intermix
  357. numbers in the document with numbers you enter at  the  keyboard,
  358. use  parenthesized  expressions,  and  do automatic horizontal or
  359. vertical totals at the touch of a key. 
  360.  
  361. GRAPHICS
  362.  
  363.    NYW  allows  you  to  intermix  text  and  ASCII  line-drawing
  364. graphics  in  the same document. At the touch of a keystroke, you
  365. can go into graphics  mode,  and  use  several  keys  to  produce
  366. horizontal and vertical lines, corners, and tees. This allows the
  367. user to create charts, and integrate them into the document. 
  368.  
  369. MULTI COLUMN EDITING
  370.  
  371.    In   addition  to  the  block  cut-and-paste  facilities,  NYW
  372. supports cutting and pasting of columns of text. There is also  a
  373. facility  for  taking  existing  text,  and  rearranging  it in a
  374. multi-column format. This  feature  is  useful  to  magazine  and
  375. newspaper publishers. 
  376.  
  377. SAFETY FEATURES
  378.  
  379.    NYW  gives  the user two options to help prevent total loss of
  380. data in the event of system crashes. NYW  will  create  a  backup
  381. version of a file whenever you save your current editing session.
  382. NYW  will  also save all of the keystrokes that you have typed in
  383. an editing session. If the system crashes while you are editing a
  384. document, you can replay any number of keystrokes at  a  time  to
  385. recreate  your  document.  You can choose how many keystrokes NYW
  386. will wait for before saving the current "batch" of keystrokes you
  387. have typed. 
  388.  
  389.  
  390. INFORMATION
  391.  
  392.      For more information on NYW, contact :
  393.  
  394.       Marc Adler
  395.       MAGMA Systems
  396.       138-23 Hoover Ave.
  397.       Jamaica, New York 11435
  398.       (718) 793-5670
  399.             793-5677
  400.